A Locale represents a specific geographical, political, or cultural region

A Locale represents a specific geographical, political, or cultural region. An operation that requires a Locale to perform its task is called locale-sensitive and uses the Locale to tailor information for the user. For example, displaying a number is a locale-sensitive operation--the number should be formatted according to the customs/conventions of the user's native country, region, or culture. In the C APIs, a locales is simply a const char string.

You create a Locale with one of the three options listed below. Each of the component is separated by '_' in the locale string.

.      newLanguage
.
.      newLanguage + newCountry
.
.      newLanguage + newCountry + newVariant

The first option is a valid ISO Language Code. These codes are the lower-case two-letter codes as defined by ISO-639. You can find a full list of these codes at a number of sites, such as:
http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt

The second option includes an additonal ISO Country Code. These codes are the upper-case two-letter codes as defined by ISO-3166. You can find a full list of these codes at a number of sites, such as:
http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html

The third option requires another additonal information--the Variant. The Variant codes are vendor and browser-specific. For example, use WIN for Windows, MAC for Macintosh, and POSIX for POSIX. Where there are two variants, separate them with an underscore, and put the most important one first. For example, a Traditional Spanish collation might be referenced, with "ES", "ES", "Traditional_WIN".

Because a Locale is just an identifier for a region, no validity check is performed when you specify a Locale. If you want to see whether particular resources are available for the Locale you asked for, you must query those resources. For example, ask the UNumberFormat for the locales it supports using its getAvailable method.
Note: When you ask for a resource for a particular locale, you get back the best available match, not necessarily precisely what you asked for. For more information, look at UResourceBundle.

The Locale provides a number of convenient constants that you can use to specify the commonly used locales. For example, the following refers to a locale for the United States:

.      ULOC_US

Once you've specified a locale you can query it for information about itself. Use uloc_getCountry to get the ISO Country Code and uloc_getLanguage to get the ISO Language Code. You can use uloc_getDisplayCountry to get the name of the country suitable for displaying to the user. Similarly, you can use uloc_getDisplayLanguage to get the name of the language suitable for displaying to the user. Interestingly, the uloc_getDisplayXXX methods are themselves locale-sensitive and have two versions: one that uses the default locale and one that takes a locale as an argument and displays the name or country in a language appropriate to that locale.

The ICU provides a number of services that perform locale-sensitive operations. For example, the unum_xxx functions format numbers, currency, or percentages in a locale-sensitive manner.

.    UErrorCode success = U_ZERO_ERROR;
.    UNumberFormat *nf;
.    const char* myLocale = "fr_FR";
.
.    nf = unum_open( UNUM_DEFAULT, NULL, success );          
.    unum_close(nf);
.    nf = unum_open( UNUM_CURRENCY, NULL, success );
.    unum_close(nf);
.    nf = unum_open( UNUM_PERCENT, NULL, success );   
.    unum_close(nf);

Each of these methods has two variants; one with an explicit locale and one without; the latter using the default locale.

.
.    nf = unum_open( UNUM_DEFAULT, myLocale, success );          
.    unum_close(nf);
.    nf = unum_open( UNUM_CURRENCY, myLocale, success );
.    unum_close(nf);
.    nf = unum_open( UNUM_PERCENT, myLocale, success );   
.    unum_close(nf);

A Locale is the mechanism for identifying the kind of services (UNumberFormat) that you would like to get. The locale is just a mechanism for identifying these services.

Each international serivce that performs locale-sensitive operations allows you to get all the available objects of that type. You can sift through these objects by language, country, or variant, and use the display names to present a menu to the user. For example, you can create a menu of all the collation objects suitable for a given language. Such classes implement these three class methods:

.      const char* uloc_getAvailable(int32_t index);
.      int32_t uloc_countAvailable();
.      int32_t
.      uloc_getDisplayName(const char* localeID,
.                const char* inLocaleID, 
.                UChar* result,
.                int32_t maxResultSize,
.                 UErrorCode* err);
.

alphabetic index hierarchy of classes

this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de